Skip to main content

User Creation and Signup

To create a new user account, send a POST request to the /signup endpoint with the necessary fields: name, email, and password.

Endpoint: POST {{base_url}}/api/users/signup/password

Sample Request:

{
"name": "John Doe",
"email": "johndoe@example.com",
"password": "abc1234567890"
}

After the signup request is processed, the system will send a verification email to the provided address. The user must click the verification link, which directs to a GET request at the /verify-email endpoint with a verification token. Once verified, the user can log in. To log in, send a POST request to the /login endpoint with the email and password in the request body.

Endpoint: POST {{base_url}}/api/users/login/password

Sample Request:

{
"email": "johndoe@example.com",
"password": "abc1234567890"
}

Upon successful login, an authentication token is returned, which the client stores for authenticated requests. Users with invitations to join an organization can accept by making a POST request to the /organisation-invitations endpoint with the invitation token.

Note: Replace {{base_url}} with the actual base URL of the API.